API endpoints

Household refrigerating appliances

The base URL for all paths is https://create-energy-label.service.gov.uk. No authentication is required for any endpoints.

Household fridges and freezers: arrow image

Path

/api/v1/household-refrigerating-appliances/household-fridges-and-freezers/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
labelColour	The colour of the arrow image. Use a colour arrow if you can. You can use a black and white arrow if your material is being printed in black and white. You shouldn't use black and white arrows on the internet. Must be one of: COLOUR BLACK_AND_WHITE	String
efficiencyRating	Energy efficiency class indicator. Must be one of: A B C D E F G	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "labelColour": "COLOUR", "efficiencyRating": "A" }

Household fridges and freezers: energy label

You must attach the label to the front or top of the product so that it’s easy to see. If it's a built-in appliance it doesn't have to be attached to the product, but it must still be easy to see. Labels must be at least 96mm x 192mm when printed.

Path

/api/v1/household-refrigerating-appliances/household-fridges-and-freezers/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
efficiencyRating	Energy efficiency class. Must be one of: A B C D E F G	String
annualEnergyConsumption	Annual energy consumption (AEC) in kWh per year. This may be up to 3 digits long.	Integer
noiseEmissions	Airborne acoustical noise emissions expressed in dB(A) re 1 pW. This may be up to 2 digits long.	Integer
chillCompartment	Does the model have any chill or unfrozen compartments?	Boolean
chillVolume	Total volume of chill and unfrozen compartments in litres (l). Only required if chillCompartment is true. This may be up to 3 digits long.	Integer
frozenCompartment	Does the model have any frozen compartments?	Boolean
frozenVolume	Total volume of frozen compartments in litres (l). Only required if frozenCompartment is true. This may be up to 3 digits long.	Integer
noiseEmissionsClass	Airborne acoustic noise emission class. Must be one of: A B C D	String
qrCodeUrl	Enter a link to the product information sheet. Links must start with http:// or https:// and contain at least one dot (.) character.	String

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A", "annualEnergyConsumption": 1, "noiseEmissions": 1, "chillCompartment": true, "chillVolume": 1, "frozenCompartment": true, "frozenVolume": 1, "noiseEmissionsClass": "A", "qrCodeUrl": "https://example.com" }

Wine storage appliances: arrow image

Path

/api/v1/household-refrigerating-appliances/wine-storage-appliances/arrow-image

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
productPriceHeightPx	Enter height of the product's price (in pixels). This may be up to 3 digits long.	Integer
labelOrientation	Arrow direction. Must be one of: LEFT RIGHT	String
labelFormat	Image format. Must be one of: JPEG PNG	String
labelColour	The colour of the arrow image. Use a colour arrow if you can. You can use a black and white arrow if your material is being printed in black and white. You shouldn't use black and white arrows on the internet. Must be one of: COLOUR BLACK_AND_WHITE	String
efficiencyRating	Energy efficiency class indicator. Must be one of: A B C D E F G	String

Example request body

{ "productPriceHeightPx": 100, "labelOrientation": "LEFT", "labelFormat": "JPEG", "labelColour": "COLOUR", "efficiencyRating": "A" }

Wine storage appliances: energy label

You must attach the label to the front or top of the product so that it’s easy to see. If it's a built-in appliance it doesn't have to be attached to the product, but it must still be easy to see. Labels must be at least 96mm x 192mm when printed.

Path

/api/v1/household-refrigerating-appliances/wine-storage-appliances/energy-label

Body schema

Send a POST request to the path above. The body of the request must be a JSON object with the following properties:

Property	Description	Type
outputFormat	Format of the generated label. Optional, defaults to PDF if not set. Must be one of: PDF PNG JPEG	String
supplierName	Supplier's name or trade mark.	String
modelName	Supplier's model identification code.	String
efficiencyRating	Energy efficiency class. Must be one of: A B C D E F G	String
annualEnergyConsumption	Annual energy consumption (AEC) in kWh per year. This may be up to 3 digits long.	Integer
bottleCapacity	Rated capacity in number of standard wine bottles. This may be up to 3 digits long.	Integer
noiseEmissions	Airborne acoustical noise emissions expressed in dB(A) re 1 pW. This may be up to 2 digits long.	Integer
noiseEmissionsClass	Airborne acoustic noise emission class. Must be one of: A B C D	String
qrCodeUrl	Enter a link to the product information sheet. Links must start with http:// or https:// and contain at least one dot (.) character.	String

Example request body

{ "outputFormat": "PDF", "supplierName": "example", "modelName": "example", "efficiencyRating": "A", "annualEnergyConsumption": 1, "bottleCapacity": 1, "noiseEmissions": 1, "noiseEmissionsClass": "A", "qrCodeUrl": "https://example.com" }